Skip to content

. d use absolute paths#244

Merged
JayBazuzi merged 1 commit intomainfrom
JayBazuzi/absolute-paths
May 3, 2026
Merged

. d use absolute paths#244
JayBazuzi merged 1 commit intomainfrom
JayBazuzi/absolute-paths

Conversation

@JayBazuzi
Copy link
Copy Markdown
Contributor

@JayBazuzi JayBazuzi commented Feb 8, 2026 •
edited by sourcery-ai Bot
Loading

Summary by Sourcery

Documentation:

  • Change internal documentation links from relative to absolute paths for diff tools, configuration files, images, and related how-to guides.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Feb 8, 2026 •
edited
Loading

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR updates several documentation markdown files to use root-relative (absolute-from-site-root) paths instead of relative paths for internal links and images, improving link robustness across different rendering contexts.

File-Level Changes

Change Details Files
Switch documentation links for diff tool configuration resources to root-relative paths.
  • Update markdown link to diff_reporters.csv to use a /diff_reporters.csv root-relative URL.
  • Update markdown link to reporters.json configuration file to use a /approvaltests/reporters/reporters.json root-relative URL.
 docs/tutorial/intro-to-reporters.md
Update binary verification example image path to be root-relative.
  • Change the approved image screenshot path in the verify-binary how-to guide to /tests/approved_files/VerifyTests.test_verify_file_binary_file.approved.png.
 docs/how_to/verify-binary.md
Fix an empty internal reference in a mob session retro by linking explicitly to the relevant how-to doc using a root-relative path.
  • Replace an empty markdown link with a named link pointing to /docs/how_to/verify_both_logs_and_results.md.
 mob-sessions-retros/2023-09-17 error_on_multiple_verify_calls_for_single_approved_file.md
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@JayBazuzi JayBazuzi marked this pull request as ready for review May 3, 2026 16:12
@JayBazuzi JayBazuzi merged commit ae1a354 into main May 3, 2026
118 of 128 checks passed
sourcery-ai[bot]
sourcery-ai Bot reviewed May 3, 2026
View reviewed changes
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Switching to root-relative links (e.g. /diff_reporters.csv) may break navigation when viewing the Markdown directly on GitHub or outside the built docs site, since /... resolves to the domain root rather than the repository root; consider whether repo-relative (../../...) or site-relative paths (via the docs generator config) are more appropriate for your use cases.
  • The updated link in mob-sessions-retros/2023-09-17...md points to /docs/how_to/verify_both_logs_and_results.md; double-check that this path resolves correctly in whichever context this retrospective is consumed (GitHub vs generated site), as it previously relied on a relative path into ../docs.
Prompt for AI Agents 
Please address the comments from this code review:

## Overall Comments
- Switching to root-relative links (e.g. `/diff_reporters.csv`) may break navigation when viewing the Markdown directly on GitHub or outside the built docs site, since `/...` resolves to the domain root rather than the repository root; consider whether repo-relative (`../../...`) or site-relative paths (via the docs generator config) are more appropriate for your use cases.
- The updated link in `mob-sessions-retros/2023-09-17...md` points to `/docs/how_to/verify_both_logs_and_results.md`; double-check that this path resolves correctly in whichever context this retrospective is consumed (GitHub vs generated site), as it previously relied on a relative path into `../docs`.
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JayBazuzi